home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / sss_rate.arc / SSS-RATE.DOC < prev    next >
Text File  |  1989-07-03  |  15KB  |  431 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                             ////////////////////////////// 
  16.                            //  SMALL SYSTEMS SOFTWARE  // 
  17.                           //                          // 
  18.                          //        PRESENTS          // 
  19.                         //           AN             // 
  20.                        //      EVENT RATING        // 
  21.                       //                          // 
  22.                      //       UTILITY FOR        // 
  23.                     //                          // 
  24.                    //         PCB 14           // 
  25.                   //        (SSS-RATE)        // 
  26.                  ////////////////////////////// 
  27.  
  28.                  (c)1989 Small Systems Software 
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.      SSS-RATE  is a utility that reads a configuration file 
  58. created by the sysop. This file (SSS-RATE.CFG) contains 11 vital 
  59. pieces of information. 
  60.  
  61.        1. The name and version number of SSS-RATE. 
  62.        2. The name and pathway location of the USER file. 
  63.        3. Should the user file be backed up?  (y or n) 
  64.        4. The name and location where the USER file is to be backed up. 
  65.        5. The name and pathway of the RATIO file (SSS-RATE.RAT) 
  66.        6. The path and filename of the caller log 
  67.        7. Should the program log it activity to a file? (y or n) 
  68.        8. The path and filename where for activity log. 
  69.        9. Whether SSS-RATE is to use a BYTE or FILE ratio. 
  70.       10. Is SSS-RATE to run on a network? (y or n) 
  71.       11. The GRACE BYTES if a BYTE ratio is used   
  72.      
  73.      SSS-RATE.CFG is an ASCII text file and is created when the program is 
  74. first run.  DO NOT use a text editor to alter this file except as noted below. 
  75. It is CASE sensitive and must be created by SSS-RATE. 
  76.       
  77.      The authors of this program make no warranty, either 
  78. expressed or implied, as to the fitness of this software for any 
  79. purpose, and assume no liability for any damages, either loss of 
  80. data, hardware failure, inadaptability for use, or any other 
  81. circumstance which might arise from it's usage. 
  82.  
  83.      The software contained herein is Copyright 1989, Small 
  84. Systems Software. No charges may be accessed for distributing the 
  85. program, other than circumstances outlined below: 
  86.   
  87.      On a SUBSCRIPTION BBS, the ONLY charge which may be made for 
  88. this software is a USAGE charge for time on the system. Those 
  89. systems which charge on a file by file or byte by byte basis must 
  90. either adjust their charges to reflect the FREE downloading of 
  91. this product, or refrain from it's posting. 
  92.  
  93.      This does not mean that this program is free. On the 
  94. contrary, this IS a copyrighted program, and a contribution ($15 
  95. suggested) is requested. Anyone contributing at least $15 will be given access 
  96. to a special conference on EXCALIBUR BBS [(904) 751-3970] for user 
  97. support of our  products.  A registration fee of $20 will allow 
  98. you to download updates to this program.  Contributors that send $35 
  99. or more will also be able, for a period of 2 years, to download 
  100. additional programs which will allow multiple scripts to be read, 
  101. for things such as SPECIAL CONFERENCE ADMITTANCE, SPECIAL  
  102. SECURITY LEVELS, etc., as they become available. 
  103.  
  104.  
  105.  
  106.  
  107.  
  108.   
  109.  
  110.  
  111. FILES INCLUDED IN SSS-RATE  
  112. ------------------------------- 
  113.  
  114.                SSS-RATE.EXE   <===> THE MAIN PROGRAM 
  115.                SSS-BYTE.CFG   <===> SAMPLE BYTE RATIO CONFIG FILE 
  116.                SSS-FILE.CFG   <===> SAMPLE FILE RATIO CONFIG FILE 
  117.                SSS-SMPL.RAT   <===> SAMPLE RATIO FILE 
  118.                SSS-RATE.DOC   <===> THIS FILE 
  119.  
  120.  
  121.  
  122.  
  123. USING SSS-RATE 
  124. --------------- 
  125.      Examine the auxillary files, SSS-BYTE.CFG, SSS-FILE.CFG and  
  126. SSS-SMPL.RAT with any text editor or simply use the DOS 'Type' command. 
  127. Decide if you would like to rate your users by File or Byte.  Make a list 
  128. of all the user levels that you wish to include in the Ratio file. 
  129. It is not necessary that you include ALL the user levels BUT only  
  130. those levels that you wish SSS-RATE to evaluate.  User levels higher 
  131. and Lower than those listed in the RATIO file are  automatically 
  132. excluded from evaluation.  That is, if you desire to rate users 
  133. from level 30 to level 60, then level 70 or level 25 users are   
  134. excluded since they lie outside the parameters of the RATIO file. 
  135. BUT you may ALSO exclude a level 45 user if that level is omitted 
  136. from the RATIO file. 
  137.  
  138.      Next, using any ASCII text editor, create your own RATIO 
  139. file.   Be sure to review your PWRD file so as not to include a level 
  140. in the RATIO file that does not exist in the PWRD file.  Doing so will  
  141. cause any user given this new level to be allowed 10 minutes per day with 
  142. 0 download bytes.  A typical RATIO file based on number of FILES might look  
  143. like this:  (The data following the '<===" is not to be typed in.) 
  144.  
  145.      -50,30  <=== User lowered to level 30, dnld/upld ratio => 50:1 
  146.      -40,35  <=== User lowered to level 35, dnld/upld ratio => 40:1 & < 50:1 
  147.      -30,40  <=== User lowered to level 40, dnld/upld ratio => 30:1 & < 40:1 
  148.      -20,45  <=== User lowered to level 45, dnld/upld ratio => 20:1 & < 30:1 
  149.        0,50  <=== Normal user level, 0 - 19 downloads, 0 - 4 uploads 
  150.        5,55  <=== User raised to level 55, upld/dnld ratio => 5:1 & < 10:1 
  151.       10,60  <=== User raised to level 60, upld/dnld ratio => 10:1 
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.      A RATIO file based on number of BYTES would look like this also, but, in 
  166. order to figure how the ratios will actually be calculated, you have to take  
  167. the GRACE BYTES parameter into account as well. The GRACE BYTES are the MAXIMUM 
  168. number of UPLOAD CREDITS given to a user during the run of the program  
  169. IF AND ONLY IF: 
  170.  
  171.    1: Their ACTUAL UPLOADS are LESS THAN that figure and 
  172.    2: Their ACTUAL DOWNLOADS are GREATER THAN that number. 
  173.  
  174.     Otherwise, should their UPLOADS exceed GRACE BYTES, they have NOTHING  
  175. added to their UPLOAD count. If they have made uploads, but have LESS THAN  
  176. GRACE BYTES in uploads, their UPLOAD count will be increased IF their DOWNLOADS  
  177. are GREATER than their uploads. If they have no UPLOADS, their UPLOAD count  
  178. will increase to a maximum of GRACE BYTES, or DOWNLOADS, whichever is the  
  179. lesser. The following chart illustrates this point. 
  180.  
  181.             |GRACE BYTES<DOWNLOADS|GRACE BYTES=DOWNLOADS|GRACEBYTES>DOWNLOADS 
  182. ------------------------------------------------------------------------------ 
  183. GRACE BYTES |                     |                     | 
  184.      <      |    Nothing added    |    Nothing added    |    Nothing added 
  185.   UPLOADS   |                     |                     | 
  186. ------------------------------------------------------------------------------ 
  187. GRACE BYTES |                     |                     | 
  188.      =      |   Nothing added     |    Nothing added    |    Nothing added 
  189.   UPLOADS   |                     |                     | 
  190. ------------------------------------------------------------------------------ 
  191. GRACE BYTES |                     |                     | 
  192.      >      |    UPLOADS=G. B.    |    UPLOADS=G. B.    |  UPLOADS=DOWNLOADS 
  193.   UPLOADS   |                     |                     | 
  194.  
  195.    In other words, the UPLOAD credits will NEVER exceed either GRACE BYTES or  
  196. DOWNLOADS unless they are ACTUALLY GREATER than those values. That way, a user 
  197. who has downloaded 500 bytes and uploaded 0 will only get credit for 500 bytes  
  198. of uploads, even though GRACE BYTES may be set at 75,000. This means that the  
  199. BEST a user can do on FREEBIE credits is a 1:1 transfer ratio, rather than the  
  200. 15:1 that would be achieved if GRACE BYTES were added without taking the ACTUAL 
  201. DOWNLOADS into account. 
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.    The ratio/GRACE BYTE limits you set are figured by taking U/L-D/L ratios 
  219. you to establish, and the number of bytes you wish to allow a user to download 
  220. before being penalized. If you want the first break to be at a 10:1 download  
  221. ratio, and not have anyone penalized before they have downloaded 500K, you  
  222. would plug in the values into this formula: 
  223.   
  224.           ALLOWED DOWNLOADS/RATIO=GRACE BYTES 
  225.   
  226.  Using these values you would get: 
  227.   
  228.           500,000/10=50,000 
  229.  
  230.    Setting GRACE BYTES to 50,000 with the ratios set at 10:1, 20:1 and 30:1 
  231. would mean that the user would hit his/her first drop in level at 500,000 
  232. bytes, the second at 1 MEG, and the third at 1.5 MEG. 
  233.  
  234.  
  235.     ************ NOTE ON USING THE GRACE BYTES PARAMETER ************ 
  236.  
  237.             The GRACE BYTES parameter is ONLY used internally 
  238.            by the program. This value is NEVER written to the 
  239.            user file, therefore, the users statistics are NEVER 
  240.            altered by the use of this product!!!!! 
  241.  
  242.             Also, this parameter, and THIS PARAMETER ONLY may be 
  243.            adjusted with a text editor to keep from having to  
  244.            go through the entire SETUP procedure repeatedly. BUT, 
  245.            due to the fact that ALL OTHER INFORMATION is sensitive 
  246.            to CASE and STRING LENGTH, we **STRONGLY** recommend  
  247.            that you **DO NOT** edit anything OTHER THAN THE G.B. 
  248.            PARAMETER with a text editor!!!!! 
  249.  
  250.  
  251.  
  252.      Now that you have created the Ratio file, you are ready to 
  253. run SSS-RATE and create the CONFIG file.  Copy SSS-RATE.EXE and 
  254. the RATIO file to a subdirectory of your choice.  Type SSS-RATE 
  255. and it will look for the CONFIG file.  When it does not locate 
  256. it in the same subdirectory, it will prompt you for the information 
  257. to include in a new CONFIG file.  Simply answer the questions 
  258. as they appear on screen.  At the end of this procedure, it will 
  259. ask you if the information is correct.  If you answer 'N', then 
  260. it will repeat the procedure.  If you answer 'Y', it will save 
  261. the information to SSS-RATE.CFG, and then exit to DOS.  Now you 
  262. will need to run SSS-RATE again and watch the results of the  
  263. evaluation.   
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.      Please be sure that you have SSS-RATE save the USER file to 
  273. a backup the first time that you run it to create the CONFIG file. 
  274. This is just a precaution but a wise one since you may not be prepared 
  275. for some of the results.  If they don't meet your expectations, simply 
  276. copy the USER backup file to the original and edit the RATIO file  
  277. if needed.  If the CONFIG file needs to be changed, delete it and run 
  278. SSS-RATE again.  DO NOT TRY TO EDIT SSS-RATE.CFG WITH A TEXT EDITOR!! 
  279.                   (Other than outlined above.) 
  280.  
  281.  
  282.      If you have chosen to use BYTE rather then FILE for evaluation, 
  283. then you may want to consider using GRACE byte quantities.  This is only 
  284. available if you choose BYTE when creating the CONFIG file.  GRACE byte 
  285. quantities are like UPLOAD bytes that a new user is given until their 
  286. total upload byte quantity is equal to or exceeds the GRACE byte quanity. 
  287. You may want to experiment around with this AND the BYTE RATIOs to achieve 
  288. a more balanced evaluation that meets your expectations.    
  289.  
  290. USING SSS-RATE IN THE EVENT 
  291. ----------------------------- 
  292.      To run SSS-RATE in your EVENT, all that is needed is to change to 
  293. the subdirectory where SSS-RATE is located and tell the event to run it. 
  294.    
  295.                  cd\pcb\main   <=== Change to proper location 
  296.                  SSS-RATE      <=== Run SSS-RATE 
  297.                  cd\pcb        <=== Change back to what ever area you wish 
  298.   
  299.      SSS-RATE expects to find SSS-RATE.CFG in the same subdirectory where 
  300. SSS-RATE.EXE is located.  You may use any area for these files BUT they 
  301. MUST be located together. 
  302.  
  303.      You can also run SSS-RATE manually at any time, simply by typing 
  304. SSS-RATE while located in it's directory. 
  305.  
  306. NETWORK USERS 
  307. -------------- 
  308.  
  309.     This program supports RECORD-LEVEL locking on the user file. If it  
  310. cannot successfully lock a record on the first attempt, it will keep trying  
  311. for a short period of time, then print a message to the caller log telling 
  312. you which record it could not access, and continue running. This is so that 
  313. having a user online in another node will not stall the program until that  
  314. user logs off. However, you may wish to review the stats for that user  
  315. manually to insure whether or not they should have had their access level 
  316. adjusted during the run.  The MAXIMUM number of users that this will affect 
  317. is one less than the number of nodes that you are running.  If you are using 
  318. PCB 14 E/3 with all 3 nodes available than the maximum number of users that 
  319. would not be rated is 2.  For E/9 that number would be 8.  Review the caller  
  320. log for the record numbers of the unadjusted users (if any). 
  321.  
  322.  
  323.  
  324.  
  325.  
  326. ----------------------------------------------------------------- 
  327.  
  328.  
  329. QUAN      ITEM                              US/CND        COST 
  330.  
  331. _____SSS-RATE Registration..................$15/$20     $________ 
  332.      (Registration, User support by BBS ONLY) 
  333.  
  334. _____SSS-RATE Download status.on BBS........$10/$13     $________ 
  335.      (Registered users ONLY) 
  336.  
  337. _____SSS-RATE Registration/Download status..$20/$26     $________ 
  338.      (Registration & latest version on BBS) 
  339.  
  340. _____SSS-RATE EXTENDED Registration - 2yrs..$35/$46     $________ 
  341.      (EXTENDED Registration, User support, Dnld Status) 
  342.  
  343. Note: User support allows downloading of  
  344. code revisions to the same version of        Sub-total  $________ 
  345. SSS-RATE as the user has registered. 
  346. Download status allows for downloading    Fla. residents: 
  347. of new versions as they become available   6.5% TAX     $________ 
  348. as well as the standard user support. 
  349.                                                   TOTAL $________ 
  350.  
  351.  
  352.                Check or money orders ONLY please! 
  353.                   DO NOT send cash in the mail! 
  354.  
  355. ----------------------------------------------------------------- 
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380. Name:____________________________________________________________ 
  381.  
  382.  
  383. Address:_________________________________________________________ 
  384.  
  385.  
  386.         _________________________________________________________ 
  387.  
  388.  
  389. City:______________________________ State:_______ Zip:___________ 
  390.  
  391.  
  392. Phone(voice):_______________________ (work):_____________________ 
  393.                PLEASE BE SURE TO INCLUDE AREA CODE 
  394.  
  395.  
  396. BBS Name:________________________________________________________ 
  397.  
  398.  
  399. BBS Phone:_________________________  Baud rate(s)________________ 
  400.  
  401.  
  402. Hours of operation:__________________________ 
  403.                     If 24HR, put "24" 
  404.  
  405.  
  406. Comments, suggestions, etc..... 
  407.  
  408. _________________________________________________________________ 
  409.  
  410.  
  411.  
  412. _________________________________________________________________ 
  413.  
  414.  
  415.  
  416. _________________________________________________________________ 
  417.  
  418.  
  419.  
  420. _________________________________________________________________ 
  421.  
  422.  
  423.  
  424. _________________________________________________________________ 
  425.  
  426.  
  427.  
  428. Mail to: 
  429.                Small Systems Software 
  430.                1452 Menlo Avenue 
  431.                Jacksonville, FL 32218